[Docs Migration] Update MDX syntax for Mintlify #28195
Open
+44
−36
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
awaiting-review
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates several documentation files to align with the Mintlify syntax as part of a documentation migration. The changes include adding blank lines after the front matter and removing legacy syntax for external links and header IDs. The modifications are consistent and correctly applied across all files. The changes look good.
Author
|
I've also started a draft PR to remove these files from the to-do list: bazel-contrib/bazel-docs#181 |
iancha1992
added
team-OSS
Member
|
Thanks! Unfortunately this will break existing bookmarks, but right now Mintlify doesn't seem to offer support for custom heading anchors (https://github.com/orgs/mintlify/discussions/1063). Let's merge it. |
fweikert
added
awaiting-PR-merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To help with docs migration efforts, this PR updates syntax for Mintlify:
{: .external}and{:#load}.This PR covers a few of the files mentioned in bazel-contrib/bazel-docs#103, which links to a list of docs that need to be updated at https://github.com/bazel-contrib/bazel-docs/blob/main/copy-upstream-docs.sh.